home *** CD-ROM | disk | FTP | other *** search
/ Joystick Magazine 1995 July & August / cd No4 joystick No62.iso / mac / pc / EMULATOR / SIMIIE / SIMIIE.DOC < prev    next >
Text File  |  1994-04-07  |  49KB  |  1,016 lines
  1.  
  2.  
  3.                                     Page 1
  4.  
  5.  
  6.                      SimSystem IIe - Version 1.0 Shareware
  7.                  Copyright (c) 1994 by American Research Inc.
  8.                             Developed by Jim Sproul
  9.                               All Rights Reserved
  10.  
  11.                             I N T R O D U C T I O N
  12.  
  13.     SimSystem IIe is amazing!  It will make your PC compatible computer
  14.     system look, sound, and act just like an Apple IIe computer!
  15.  
  16.     With SimSystem IIe you will be able to run your favorite Apple II
  17.     software.  SimSystem IIe supports all standard Apple graphics modes,
  18.     so your favorite Apple games will work perfectly.  Even the sound is
  19.     reproduced exactly!
  20.  
  21.     SimSystem IIe supports all of the standard keys on an Apple IIe
  22.     keyboard, including the Open Apple and Solid Apple keys.  And,
  23.     SimSystem IIe will let you use your PC joystick with Apple programs
  24.     that require a joystick.
  25.  
  26.     SimSystem IIe simulates an Apple IIe compatible computer with FOUR
  27.     DISK DRIVES!  Two are simulated 5 1/4 inch diskette drives, and two
  28.     are ProDOS compatible hard disk drives.  You can swap disks anytime by
  29.     pressing a function key and selecting another 'disk'.  You can even
  30.     swap disks on the two simulated hard drives!  And, SimSystem IIe
  31.     emulates the Apple Disk II floppy drive so well that you can even use
  32.     some copy protected programs with SimSystem IIe!
  33.  
  34.     SimSystem IIe does MORE than a real Apple IIe!  Programmers will love
  35.     the enhanced 65C02 monitor!  And, the built-in debugger is as powerful
  36.     as an expensive in-circuit emulator!
  37.  
  38.     SimSystem IIe can simulate an Apple IIe with a color or monochrome
  39.     monitor.  The VGA display mode is breathtaking - you'll swear you're
  40.     looking at an Apple IIe display!  And, SimSystem IIe works with CGA
  41.     and EGA display adaptors, too!
  42.  
  43.     Don't forget - SimSystem IIe is SHAREWARE!  Registered users get the
  44.     latest updated version of SimSystem IIe, a nicely printed and bound
  45.     manual (with pictures...), and the SimDisk utility (for creating
  46.     'disks' for use with SimSystem IIe).
  47.  
  48.     This manual provides a brief overview of SimSystem IIe.  Registered
  49.     users receive complete in-depth documentation.
  50.  
  51.  
  52.                                     Page 2
  53.  
  54.  
  55.                         T A B L E  O F  C O N T E N T S
  56.  
  57.               Introduction..................................Page 1
  58.  
  59.               Legal Statement...............................Page 3
  60.  
  61.               Chapter 1 - Features..........................Page 5
  62.  
  63.               Chapter 2 - System Requirements And
  64.                 Compatibility...............................Page 6
  65.  
  66.               Chapter 3 - Performance.......................Page 7
  67.  
  68.               Chapter 4 - Installation Guide................Page 8
  69.  
  70.               Chapter 5 - Getting Starting: SimSystem IIe
  71.                 Configuration...............................Page 9
  72.  
  73.               Chapter 6 - Volume Files: The SimSystem IIe
  74.                 Disk Drives.................................Page 13
  75.  
  76.               Chapter 7 - Booting The Emulator: The
  77.                 Volume Selector.............................Page 14
  78.  
  79.               Chapter 8 - The Emulator Keyboard.............Page 16
  80.  
  81.               Chapter 9 - SimSystem IIe Function Keys.......Page 17
  82.  
  83.               Chapter 10 - The SimSystem IIe Debugger.......Page 19
  84.  
  85.               Chapter 11 - Volume File Formats..............Page 21
  86.  
  87.               Appendix - Registration.......................Page 23
  88.  
  89.  
  90.                                          Page 3
  91.  
  92.  
  93.                                      Legal Statement
  94.                                      _______________
  95.  
  96.     SimSystem IIe was developed by Jim Sproul for American Research Inc. 
  97.     SimSystem IIe is copyright (c) 1994 by American Research Inc. 
  98.     SimSystem IIe and SimSystem are trademarks of American Research Inc. 
  99.     All rights reserved.
  100.  
  101.     COPYRIGHTS AND TRADEMARKS USED IN THIS DOCUMENT
  102.  
  103.     Apple, Apple IIe, Apple DOS, and Apple ProDOS are trademarks of Apple
  104.     Computer Corporation.  AppleWorks is a trademark of Claris
  105.     Corporation.  MS-DOS is a trademark of Microsoft Corporation.  IBM is
  106.     a trademark of International Business Machines Inc.  
  107.  
  108.     SIMSYSTEM IIE IS SHAREWARE.
  109.  
  110.     License is hereby granted to the end user to use SimSystem IIe for a
  111.     period of ten days for the purpose of evaluating the usefulness of the
  112.     software.  After that time the software must be purchased by sending
  113.     the registration fee, currently $50 US, to American Research Inc.  If
  114.     the registration fee is not paid after ten days the end user must stop
  115.     using the software, and must destroy any copies of the program in
  116.     his/her possession.  Instructions for registering SimSystem IIe are
  117.     provided at the end of this document.
  118.  
  119.     Bulletin Board System (BBS) operators may receive a free registration
  120.     for SimSystem IIe by making SimSystem IIe available on their BBS
  121.     system, and sending in the SimSystem IIe registration form along with
  122.     instructions for accessing the BBS.  After verifying that SimSystem
  123.     IIe is available, and that the conditions of distribution are being
  124.     met, we will send the registered version of SimSystem IIe, a printed
  125.     and bound manual, and the SimDisk utility.  The ten day evaluation
  126.     period is waived for BBS operators who make SimSystem IIe available on
  127.     their BBS system, and who comply with the terms of distribution given
  128.     below.
  129.  
  130.     DISTRIBUTION
  131.  
  132.     SimSystem IIe may be distributed, either on magnetic media or via
  133.     modem, for the purpose of exposing the product to other potential
  134.     users, providing that all original files are included, intact and
  135.     unmodified, and that no additional files are provided in association
  136.     with the product.  SimSystem IIe may NOT be distributed on a bulletin
  137.     board system (BBS) that illegally distributes copyrighted commercial
  138.     software.
  139.  
  140.     COMMERCIAL SHAREWARE DISTRIBUTION
  141.  
  142.     SimSystem IIe may be distributed by commercial shareware distribution
  143.     firms provided that the terms of distribution outlined above are
  144.     complied with, and that the shareware nature of the product is CLEARLY
  145.     stated on the product packaging and on the media (diskette, CD, etc.).
  146.  
  147.     SIMSYSTEM IIE IS AN ORIGINAL PRODUCT
  148.  
  149.                                     Page 4
  150.  
  151.  
  152.  
  153.     SimSystem IIe was written by Jim Sproul for American Research Inc. 
  154.     The program was written in 80286 assembly language, except for the
  155.     interpreted pseudo-ROM program, which was written in 65C02 assembly
  156.     language.  SimSystem IIe does NOT contain any program code in any form
  157.     (interpreted or executable) which is the copyrighted property of Apple
  158.     Computer.  (This becomes apparent if the user examines the 65C02
  159.     monitor program.)
  160.  
  161.     USE OF COMMERCIAL SOFTWARE WITH SIMSYSTEM IIE
  162.  
  163.     The end user MUST have a license from the software publisher to use
  164.     any commercial software with SimSystem IIe.  This license is usually
  165.     granted, with some limitations, when the user purchases the software. 
  166.     Some software licenses may stipulate that the software may only be
  167.     used on a computer system which is manufactured by, or under license
  168.     from, Apple Computer.  Software products bearing such a license
  169.     stipulation may NOT be used legally with SimSystem IIe.
  170.  
  171.     WARNING: The use of commercial software products with SimSystem IIe
  172.     which are not obtained through legal means (i.e., purchased) is
  173.     ILLEGAL!
  174.  
  175.     DISCLAIMER
  176.  
  177.     SimSystem IIe is provided solely for the amusement of the user. 
  178.     American Research Inc. makes no guarantee regarding the usefulness of
  179.     the product, and does not guarantee that the product will operate
  180.     uninterrupted, or will be free of errors.  American Research Inc. will
  181.     not be responsible for any damages resulting from the failure of the
  182.     product to perform as expected.  The user is  urged to read this
  183.     document in its entirety (especially the Compatibility Guide) before
  184.     using SimSystem IIe.
  185.  
  186.  
  187.                                     Page 5
  188.  
  189.  
  190.                              Chapter 1 - Features
  191.                              ____________________
  192.  
  193.     SimSystem IIe is configured to emulate an Apple IIe with the following
  194.     features:
  195.  
  196.          * 128K RAM (64K main / 64K auxiliary)
  197.          * 65C02 microprocessor
  198.          * Parallel printer adaptor in 'slot 1'
  199.          * 80-column display adaptor in 'slot 3'
  200.          * Dual floppy drive adaptor in 'slot 6'
  201.          * Dual hard drive adaptor (removeable media) in 'slot 7'
  202.  
  203.     In addition, SimSystem IIe has the following features:
  204.  
  205.          * Supports CGA, EGA, and VGA display adaptors.
  206.  
  207.          * Emulates all standard Apple display modes, including 40 column
  208.          text, 80 column text, low resolution graphics, high resolution
  209.          graphics, and double high resolution graphics.
  210.  
  211.          * Emulates full Apple keyboard, including Open Apple and Solid
  212.          Apple keys.
  213.  
  214.          * Emulates Apple joystick using standard PC game port.
  215.  
  216.          * Emulates Apple internal speaker sound.
  217.  
  218.          * Built-in enhanced 65C02 monitor.
  219.  
  220.          * Built-in 65C02 debugger supports breakpoints, single step,
  221.          register display, and more.
  222.  
  223.          * Use files on your hard disk as 'disks' for four simulated disk
  224.          drives.  Swap disks anytime by pressing a function key (even on
  225.          the simulated hard drives).
  226.  
  227.          * Special set-up screen lets you choose your PC video mode,
  228.          select printer and game port, turn on/off sound, enable/disable
  229.          debugger, etc.  Save your configuration and SimSystem IIe will
  230.          always start up the way you want it to.
  231.  
  232.  
  233.                                        Page 6
  234.  
  235.  
  236.                  Chapter 2 - System Requirements And Compatibility
  237.                  _________________________________________________
  238.  
  239.     SimSystem IIe requires a 100% IBM compatible computer system with an
  240.     80286 (or downward compatible) microprocessor.  A graphics display
  241.     adaptor (CGA, EGA, or VGA) is required.  A parallel printer adaptor
  242.     and game port are also optional.  Although not required, a hard disk
  243.     is highly recommended for maximum performance.
  244.  
  245.     SimSystem IIe will NOT work on systems with an 8086, 8088, or V20
  246.     microprocessor.  
  247.  
  248.     SimSystem IIe is NOT compatible with Microsoft Windows, and may not be
  249.     run as a DOS task under Windows.  SimSystem IIe changes the keyboard
  250.     interrupt vector, and deals directly with system hardware for maximum
  251.     performance.
  252.  
  253.     SimSystem IIe is known to be incompatible with many IBM portable
  254.     computers, and Viglen computer systems (manufactured in the U.K.).  If
  255.     you find SimSystem IIe does not function on your computer system
  256.     please write to American Research Inc., at the address provided, and
  257.     describe your computer system and the symptoms of the problem.  If we
  258.     find the problem is due to a bug in SimSystem IIe we will send you a
  259.     registered copy of SimSystem IIe at no charge!
  260.  
  261.  
  262.                                     Page 7
  263.  
  264.  
  265.                             Chapter 3 - Performance
  266.                             _______________________
  267.  
  268.     The performance of SimSystem IIe, as compared to a real Apple IIe,
  269.     will vary considerably.  This depends on the type and speed of your
  270.     microprocessor, the number of wait states imposed by your system
  271.     memory, the speed of your display adaptor, etc.
  272.  
  273.     SimSystem IIe running on an 80286 system operating at 12 MHz will be
  274.     painfully slow, and probably not useful for anything except the most
  275.     mundane tasks.  If you have a system like this then you may not be
  276.     bothered by the lackluster performance, as you are probably already
  277.     used to a lot of waiting.  You might consider donating your system to
  278.     your local Salvation Army Thrift Store or elementary school.
  279.  
  280.     SimSystem IIe running on an 80386 system operating at 20 MHz will show
  281.     adequate performance for most text based tasks, such as AppleWorks. 
  282.     However, video games will probably not offer enough of a challenge for
  283.     anyone over the age of six.
  284.  
  285.     SimSystem IIe running on an 80486SX system operating at 25 MHz will
  286.     perform well beyond the speed of an Apple IIe for computational uses,
  287.     but will perform at about the same speed for graphics operations.
  288.  
  289.     You can improve the performance of SimSystem IIe by operating the
  290.     program in CGA mode (even if you have an EGA or VGA display adaptor),
  291.     and by using the program with the debugger option turned off.
  292.  
  293.  
  294.                                     Page 8
  295.  
  296.  
  297.                         Chapter 4 - Installation Guide
  298.                         ______________________________
  299.  
  300.     Since you are reading this document you have already discovered that
  301.     the first step in installing SimSystem IIe is to extract the
  302.     individual files from the archive (SIMIIE.ZIP).
  303.  
  304.     SimSystem IIe comes with the following files:
  305.  
  306.          SIMIIE.EXE - the SimSystem IIe program
  307.          MON.ROM - the SimSystem IIe 65C02 monitor program
  308.          SLOT.ROM - the SimSystem IIe 65C02 expansion slot programs
  309.          DIAG.ROM - the SimSystem IIe 65C02 resident programs
  310.          EXP.ROM - the SimSystem IIe expansion programs
  311.          DEMO.IIE - a simple game developed with SimSystem IIe
  312.          FLOBYN.IIE - a public domain game for the Apple IIe
  313.          SIMIIE.DOC - this file
  314.  
  315.     We strongly recommend that you copy all of these files into a single
  316.     subdirectory on your PC hard drive.  We usually name this subdirectory
  317.     SIMIIE.  All of the files with the 'ROM' extension are 65C02 programs
  318.     that SimSystem IIe uses for its simulated ROM memory.  SimSystem IIe
  319.     looks for these files in the current directory on startup.
  320.  
  321.  
  322.                                     Page 9
  323.  
  324.  
  325.            Chapter 5 - Getting Started: SimSystem IIe Configuration
  326.            ________________________________________________________
  327.  
  328.     You can run SimSystem IIe by typing the following command at the
  329.     MS-DOS prompt:
  330.          SIMIIE<Enter>
  331.     Of course, the phrase <Enter> means to press the Enter key.
  332.  
  333.     If SimSystem IIe does not find a valid SIMIIE.CFG file in the startup
  334.     directory then you will be presented with the SimSystem IIe
  335.     configuration screen.  This screen allows you to select options for
  336.     SimSystem IIe, which you can save for future use.  Even after saving
  337.     your preferred configuration in the SIMIIE.CFG file you can still
  338.     change the configuration later by entering:
  339.          SIMIIE /S<Enter>
  340.     This command will cause SimSystem IIe to load the SIMIIE.CFG
  341.     configuration and display the configuration screen so that you may
  342.     make changes.  Should you ever wish to restore the factory default
  343.     configuration you can simply erase the SIMIIE.CFG file from your
  344.     startup directory, and SimSystem IIe will start just like the first
  345.     time you used it.
  346.  
  347.     Each of the configuration options is described below.
  348.  
  349.     1...Video Mode
  350.          Pressing the '1' key will cycle through each of the available
  351.          video mode options.  These options refer to the PC video mode
  352.          which SimSystem IIe will use when simulating the Apple IIe
  353.          display.  All Apple IIe display modes are supported by SimSystem
  354.          IIe regardless of which PC display mode you choose.
  355.  
  356.          CGA display mode uses a graphics screen which is 640 dots wide,
  357.          and 200 dots high, and is black-and-white.  When this option is
  358.          selected SimSystem IIe will simulate an Apple IIe with a
  359.          monochrome monitor.  This is the only option that will work for
  360.          PC computer systems with a CGA display adaptor.  However, since
  361.          screen graphics operate much faster in this mode, owners of EGA
  362.          or VGA equipped computers might choose to use this mode for some
  363.          graphics intensive programs.
  364.  
  365.          EGA display mode uses a graphics screen which is 640 dots wide,
  366.          and 200 dots high, and uses 16 colors.  In this mode SimSystem
  367.          IIe will simulate an Apple IIe with a color display.  This mode
  368.          can be used with EGA and VGA equipped systems.  This mode is also
  369.          compatible with computers having an EGA display adaptor and a
  370.          non-enhanced (CGA) monitor.
  371.  
  372.          VGA equipped machines pose a special problem for SimSystem IIe. 
  373.          The quality of the display produced by the VGA display adaptor is
  374.          much higher than that of a real Apple IIe, making it difficult to
  375.          produce a realistic looking display.  The Apple IIe display only
  376.          uses half of the available scan lines, leaving a thin black
  377.          stripe between rows of dots.  In low resolution display modes the
  378.          VGA display adaptor will actually display each row of dots twice
  379.          in order to fill in the black space.  While this process, called
  380.  
  381.                                       Page 10
  382.  
  383.  
  384.          double scanning, might produce a better looking PC display
  385.          screen, it makes a simulated Apple IIe display look bright and
  386.          chunky.  SimSystem IIe compensates for this by operating the VGA
  387.          display adaptor in the 640 by 480 dot display mode, and
  388.          intentionally skipping alternating rows of dots.  This adds the
  389.          original black space between rows of dots, producing a strikingly
  390.          realistic display.
  391.  
  392.     2...Printer Port
  393.  
  394.          SimSystem IIe simulates an Apple IIe with a parallel printer
  395.          adaptor card installed in 'slot 1'.  This option allows you to
  396.          choose which printer port on your PC to use when an Apple II
  397.          program is sending data to your printer.  Pressing the '2' key
  398.          will cycle through the available options.  If you don't have a
  399.          printer attached to your PC, or if you choose not to use a
  400.          printer with SimSystem IIe, then you can select the 'NONE'
  401.          option.
  402.  
  403.     3...Modem Port
  404.  
  405.          This option is provided in the event a future version of
  406.          SimSystem IIe is written that supports a modem card in 'slot 2'. 
  407.          The current version of SimSystem IIe does not support this.
  408.  
  409.     4...Game
  410.  
  411.          Press the '4' key to toggle this option between 'ON' and 'OFF'. 
  412.          When this option is set 'ON' SimSystem IIe will support the use
  413.          of a PC joystick with Apple II programs that require a joystick
  414.          or paddles.  If your PC system is not equipped with a game port
  415.          or joystick, or you don't wish to use a joystick with any Apple
  416.          programs, then set this option to 'OFF'.
  417.  
  418.     5...Mouse
  419.  
  420.          This option is provided in the event a future version of
  421.          SimSystem IIe is written that supports a mouse card in 'slot 4'. 
  422.          The current version of SimSystem IIe does not support this.
  423.  
  424.     6...Sound
  425.  
  426.          Press the '6' key to toggle this option between 'ON' and 'OFF'. 
  427.          When this option is set 'ON' SimSystem IIe will simulate Apple
  428.          IIe sound through the internal speaker on your PC.  If your PC is
  429.          an older (and slower) machine than you might find the simulated
  430.          audio annoying, and you may wish to set this option to 'OFF'.
  431.  
  432.     A through G...Emulator System
  433.  
  434.          These options are provided to remind you which simulated
  435.          expansion cards are installed in each SimSystem IIe 'slot'.  A
  436.          future version of SimSystem IIe might allow you to select
  437.          different simulated cards for each slot.
  438.  
  439.  
  440.                                     Page 11
  441.  
  442.  
  443.     H...Debugger
  444.  
  445.          Press the 'H' key to alternate between ON and OFF.  The SimSystem
  446.          IIe debugger will allow programmers direct access to the
  447.          simulated 65C02 microprocessor.  Using the debugger you can stop
  448.          the processor, display the contents of the 65C02 registers, step
  449.          through the program one instruction at a time, and set hardware
  450.          breakpoints, all without any adverse affect on the program being
  451.          run.  SimSystem IIe will operate more slowly while the debugger
  452.          is enabled, so you should switch it off unless you need to use
  453.          it.  Use of the SimSystem IIe debugger is described in detail in
  454.          chapter 10.
  455.  
  456.     I...Page Flip
  457.  
  458.          The Apple IIe provides two video display buffers for most display
  459.          modes, and SimSystem IIe supports this.  Some programs will
  460.          display the image from one of the two display buffers while
  461.          creating another image in the alternate buffer.  When the image
  462.          is completed the program will switch the display to the alternate
  463.          display buffer using a technique called 'page flipping'. 
  464.          SimSystem IIe tries to be intelligent about page flipping, and
  465.          only redraws the portion of the display screen which has actually
  466.          changed.  While this works fine for most graphics programs, some
  467.          programs will page flip between two completely different display
  468.          screens, causing SimSystem IIe to do a lot of screen drawing.  If
  469.          you find a graphics program is operating more slowly with
  470.          SimSystem IIe, and you suspect that page flipping is the problem,
  471.          you might try running the program with the page flipping option
  472.          turned OFF.  This will force SimSystem IIe to display only one
  473.          display buffer.  You can select which of the two buffers is
  474.          displayed while the program is running by pressing the F6 key. 
  475.          (Use of the F6 key is described in chapter 9.)
  476.  
  477.     J...Flash Text
  478.  
  479.          Both the Apple IIe and the PC support a form of flashing text
  480.          when the display is operating in text mode.  On the Apple IIe the
  481.          text will alternate between normal (white on black) and inverse
  482.          (black on white) at regular intervals.  On the PC the text will
  483.          alternate between on and off.  SimSystem IIe supports the Apple
  484.          IIe style flashing text by periodically redrawing the flashing
  485.          characters in reverse.  While this produces a very realistic
  486.          simulated Apple display, it can cause a noticeable decrease in
  487.          performance on slower machines.  Turn this option OFF if you
  488.          suspect that flashing text is a problem.
  489.  
  490.     R...Run SimSystem IIe
  491.  
  492.          Select this option to start the SimSystem IIe emulator.
  493.  
  494.     S...Save Configuration
  495.  
  496.          Select this option to save the current configuration in the
  497.          SIMIIE.CFG file.  If the file already exists it will be replaced.
  498.  
  499.                                       Page 12
  500.  
  501.  
  502.          Once this file has been created SimSystem IIe will not
  503.          automatically enter the configuration mode on startup unless the
  504.          /S switch is provided on the command line.
  505.  
  506.     Esc...Return to DOS
  507.  
  508.          If, after making changes to the configuration screen, you do not
  509.          wish to start the SimSystem IIe emulator, you may return to the
  510.          MS-DOS prompt by pressing the Esc key.
  511.  
  512.  
  513.                                       Page 13
  514.  
  515.  
  516.               Chapter 6 - Volume Files: The SimSystem IIe Disk Drives
  517.               _______________________________________________________
  518.  
  519.     SimSystem IIe emulates an Apple IIe with four disk drives, two floppy
  520.     drives and two hard drives.  These simulated disk drives exist only in
  521.     software, which is to say that the disk drives don't physically exist.
  522.     An Apple II program will find all of the appropriate hardware
  523.     registers for these disk drives only because SimSystem IIe simulates
  524.     these registers.  In fact, SimSystem IIe simulates these disk drives
  525.     so well that many copy protected programs will work.
  526.  
  527.     These simulated disk drives need simulated disks in order to work. 
  528.     These disks are provided in the form of files on your PC hard drive. 
  529.     In most cases, these files contain a complete copy of the contents of
  530.     a real Apple disk.  We call these 'volume files'.
  531.  
  532.     Volume files for use with the simulated floppy drives will have the
  533.     MS-DOS extension *.IIE, while files for use with the simulated hard
  534.     drives will have the MS-DOS extension *.HDV.  SimSystem IIe provides a
  535.     special file selector that allows you to swap disks in any of the
  536.     simulated disk drives (including the simulated hard drives) by simply
  537.     selecting another volume file.
  538.  
  539.     A floppy volume file (*.IIE) will always contain 143360 bytes of data,
  540.     while a hard drive volume file (*.HDV) may vary between 800K and 16M. 
  541.     The Apple ProDOS 3 1/2 inch diskettes can be simulated by using 800K
  542.     hard drive volumes.  The simulated hard drive conforms to Apple ProDOS
  543.     standards, and can only be used with ProDOS.
  544.  
  545.     Floppy volume files (*.IIE) can contain data in two different formats;
  546.     binary and GCR.  Binary format files are always 143390 bytes in
  547.     length, while GCR format files will vary in length (usually greater
  548.     than 200K).  Binary format files are used for most applications where
  549.     program code or data is stored in standard Apple format, and no copy
  550.     protection is used.  GCR format files contain a copy of the disk data
  551.     in its purest GCR encoded format, the same way it is stored on a real
  552.     Apple II diskette.  SimSystem IIe does not interpret or translate GCR
  553.     data in any way, whichs makes this format suitable for many copy
  554.     protection methods used on Apple II products.
  555.  
  556.     You will need the SimDisk program in order to create volume files for
  557.     SimSystem IIe.  This program allows you to download Apple compatible
  558.     programs via modem, or directly from an Apple II computer system.  You
  559.     can also use a Deluxe Option Board, from Central Point Software, to
  560.     directly read Apple diskettes in your PC floppy drive.  SimDisk is
  561.     provided to registered users of SimSystem IIe.
  562.  
  563.  
  564.                                     Page 14
  565.  
  566.  
  567.              Chapter 7 - Booting The Emulator: The Volume Selector
  568.              _____________________________________________________
  569.  
  570.     You can start the SimSystem IIe emulator by selecting the 'R' option
  571.     from the configuration screen.  If you have saved your configuration
  572.     in the SIMIIE.CFG file, then the emulator will start automatically
  573.     when you run the SIMIIE program.
  574.  
  575.     Just like a real Apple IIe, the first thing SimSystem IIe will try to
  576.     do is load an operating system from one of the simulated disk drives. 
  577.     This process is called 'bootstrap', or booting.
  578.  
  579.     SimSystem IIe provides the Volume Selector to allow you to choose a
  580.     volume file for any of the simulated disk drives.  The Volume Selector
  581.     is displayed at startup so that you can select a volume file to boot. 
  582.     You can also call up the Volume Selector at any time while using
  583.     SimSystem IIe by pressing the F7 function key.
  584.  
  585.     If your keyboard fails to work at this point it is probably because
  586.     your PC keyboard system is not 100% IBM compatible, as required for
  587.     SimSystem IIe.  If this is the case then SimSystem IIe will NOT work
  588.     with your computer.  Please write to American Research at the address
  589.     provided at the end of this manual, and let us know what kind of
  590.     computer system you are using.
  591.  
  592.     The Volume Selector is displayed using the simulated Apple 80-column
  593.     display characters.  The Volume Selector box is outlined in inverse
  594.     box characters, and contains the title 'VOLUME' at the top.  Inside
  595.     the box are listed up to eight files or subdirectories on your PC hard
  596.     drive.  If the file listed is a subdirectory then the letter 'D' will
  597.     appear in the border to the left of the filename.
  598.  
  599.     The selected disk drive is listed in the bottom border of the box
  600.     after the word 'TAB' in the format 'SnDn'.  The number following the
  601.     'S' indicates the 'slot', where slot 6 is the two simulated floppy
  602.     drives, and slot 7 is the two simulated hard disk drives.  The number
  603.     following the 'D' indicates which of the two simulated disk drives in
  604.     each slot is selected, either 1 or 2.  By pressing the TAB key you can
  605.     alternate between S6D1, S6D2, S7D1, and S7D2.  Note that when either
  606.     of the two simulated floppy drives (slot 6) are selected then only
  607.     files with the extension *.IIE will be displayed.  Similarly, when
  608.     either of the two simulated hard drives (slot 7) are selected then
  609.     only files with the extension *.HDV will be displayed.  All
  610.     subdirectories will be displayed regardless of which simulated disk
  611.     drive is selected.
  612.  
  613.     The selected file or subdirectory is displayed by highlighting its
  614.     name in inverse characters (black on white).  You can change the
  615.     selected file or subdirectory by using the UP and DOWN arrow keys
  616.     (also called cursor keys) on your PC keyboard.  The list will scroll
  617.     when the highlight bar reaches the bottom or top of the window, if
  618.     more selections exist.  You can choose a file or subdirectory by
  619.     moving the highlight bar over the name and pressing the Enter key.  If
  620.     the selection is a subdirectory then the contents of that directory
  621.     will be displayed in the window.  You can move to the previous
  622.  
  623.                                     Page 15
  624.  
  625.  
  626.     subdirectory by selecting the '..' option from the list.  If the
  627.     selection is a volume file then that file will be 'installed' in the
  628.     selected simulated disk drive, and the Volume Selector will disappear.
  629.  
  630.     The current MS-DOS path is displayed at the bottom of the screen.
  631.  
  632.     You can exit from the Volume Selector without choosing a file by
  633.     pressing the Esc key.  None of the selected volume files will be
  634.     changed.  Leaving the Volume Selector displayed at boot time by
  635.     pressing the Esc key is equivalent to starting an Apple IIe without
  636.     any disks in the disk drives.  Like an Apple IIe, SimSystem IIe will
  637.     run continuously trying to read a non-existent disk.  However, just
  638.     like an Apple IIe, you can press RESET (function key F5) to proceed
  639.     directly to the built-in BASIC interpreter.  Of course, no operating
  640.     system is loaded so you won't be able to load or save any programs. 
  641.     However, you can still play with BASIC, or the built-in monitor
  642.     program.
  643.  
  644.     Once you have selected a volume file SimSystem IIe will begin loading
  645.     the operating system from the volume.  After that, things works pretty
  646.     much like a real Apple IIe!
  647.  
  648.  
  649.                                     Page 16
  650.  
  651.  
  652.                        Chapter 8 - The Emulator Keyboard
  653.                        _________________________________
  654.  
  655.     Most of the keys on your PC keyboard work with the emulator.  All of
  656.     the alphanumeric keys are the same, including Esc, Shift, Ctrl, Tab,
  657.     Caps Lock, Backspace, and the arrow (cursor) keys.
  658.  
  659.     Functions keys F1 through F10 are used for special SimSystem IIe
  660.     commands, and are not used by any Apple II programs.  The numeric
  661.     keypad keys are equivalent to the numeric keys on the main keyboard.
  662.  
  663.     The Alt key to the left of the space bar is used for the Open Apple
  664.     key.  The Alt key to the right of the space bar is used for the Solid
  665.     Apple Key.  Note that the screen characters that represent these keys
  666.     are replaced with Open Diamond and Solid Diamond (to avoid copyright
  667.     problems with Apple Computer).
  668.  
  669.     None of the following keys perform any function with SimSystem IIe.
  670.  
  671.          Print Screen   Scroll Lock    Pause
  672.          Insert         Home           Page Up
  673.          Delete         End            Page Down
  674.          Num Lock
  675.  
  676.     Some Apple operating systems, like Apple DOS, do not support all of
  677.     the keys on an enhanced Apple IIe.  For example, Apple DOS does not
  678.     recognize lower case characters.  However, like an Apple IIe,
  679.     SimSystem IIe starts up in Caps Lock mode.  In addition, Apple DOS and
  680.     AppleSoft BASIC do not recognize the Backspace key, and use instead
  681.     the left arrow key.  In other words, use the keyboard just as you
  682.     would on a real Apple IIe.
  683.  
  684.  
  685.                                     Page 17
  686.  
  687.  
  688.                     Chapter 9 - SimSystem IIe Function Keys
  689.                     _______________________________________
  690.  
  691.     Some of the things you would do with a real Apple IIe are not directly
  692.     possible with an emulator program.  SimSystem IIe uses function keys
  693.     F1 through F10 to perform these special tasks.  The bar at the bottom
  694.     of the screen is used to remind you of the purpose of these function
  695.     keys.  Please note that this reminder bar is temporarily replaced by
  696.     the MS-DOS path when using the Volume Selector, and by the debugger
  697.     display (when enabled).  Each of the function keys is described below.
  698.  
  699.     F1 SHOW (Debugger)
  700.  
  701.          This key is used only when the SimSystem IIe debugger is enabled.
  702.          This key allows you to alternate between the debugger display and
  703.          the reminder bar.  The debugger display is described in the
  704.          chapter 10 of this manual.
  705.  
  706.     F2 SNGL (Debugger)
  707.  
  708.          This key is used only when the SimSystem IIe debugger is enabled.
  709.          This key allows you to alternate between RUN and STEP mode.  In
  710.          RUN mode the simulated 65C02 processor will run continuously.  In
  711.          STEP mode the simulated 65C02 processor can be stepped one
  712.          instruction at a time using function key F4.
  713.  
  714.     F3 BRK (Debugger)
  715.  
  716.          This key is used only when the SimSystem IIe debugger is enabled.
  717.          This key allows you to set a breakpoint address.  When the 65C02
  718.          processor reaches the breakpoint address it will automatically
  719.          switch into the STEP mode (see function key F2 and F4
  720.          descriptions).
  721.  
  722.     F4 STEP (Debugger)
  723.  
  724.          This key is used only when the SimSystem IIe debugger is enabled.
  725.          This key allows you to step the 65C02 processor one instruction
  726.          at a time.  This key is only effective when the 65C02 processor
  727.          is in STEP mode (see function key F2 description).
  728.  
  729.     F5 RST
  730.  
  731.          This key is equivalent to the RESET key on a real Apple IIe. 
  732.          Pressing this key will cause the simulated 65C02 processor to be
  733.          reset.  Some Apple II programs will alter the 65C02 reset
  734.          address, which prevents the program from being stopped.  These
  735.          programs will behave similarly with SimSystem IIe.  See function
  736.          key F9 description below.
  737.  
  738.     F6 FLIP
  739.  
  740.          This key is used when the Page Flip option (on the configuration
  741.          screen) is turned OFF.  Use this key with graphics mode programs
  742.          to select which of the two display buffers will be shown on the
  743.  
  744.                                       Page 18
  745.  
  746.  
  747.          screen.  Pressing this key will cause SimSystem IIe to switch
  748.          between the two display buffers.  This feature is useful to
  749.          programmers who want to watch screen data being created in a
  750.          display buffer that would normally be hidden from view.
  751.  
  752.     F7 DISK
  753.  
  754.          Use this key to access the Volume Selector.  Use of the Volume
  755.          Selector is described in chapter 7 of this manual.  The Volume
  756.          Selector is sometimes useful as a PAUSE function in some games,
  757.          since the emulator stops while the Volume Selector is displayed.
  758.  
  759.     F8 JOY
  760.  
  761.          This key is only useful if the Game Port option is enabled (on
  762.          the configuration screen).  As you probably already know, not all
  763.          PC joysticks are the same.  In addition, not all PC game port
  764.          adaptors are the same.  Most PC games that use a joystick provide
  765.          an option for 'calibrating' the stick to work properly with the
  766.          game.  SimSystem IIe provides function key F8 for this purpose. 
  767.          Position your joystick in the center position and press F8.  A
  768.          reminder box will pop up to inform you when the calibration is
  769.          complete.  THIS PROCESS MUST BE PERFORMED EVERY TIME YOU RUN
  770.          SIMSYSTEM IIE, AND BEFORE USING THE JOYSTICK!  If your joystick
  771.          features calibration adjustments you should set them in the
  772.          center position before pressing F8.  The SimSystem IIe joystick
  773.          emulation should work with virtually all Apple II games that use
  774.          a joystick.
  775.  
  776.     F9 PWR
  777.  
  778.          Pressing this key is essentially the same as switching off an
  779.          Apple IIe for a moment, then switching it back on.  Use the
  780.          Volume Selector to select a new disk to boot before pressing F9.
  781.  
  782.     F10 BYE
  783.  
  784.          Use this key to return to the MS-DOS prompt.  No warnings are
  785.          given, so press this key only if you want to leave SimSystem IIe.
  786.  
  787.  
  788.                                       Page 19
  789.  
  790.  
  791.                       Chapter 10 - The SimSystem IIe Debugger
  792.                       _______________________________________
  793.  
  794.     The SimSystem IIe debugger is an advanced feature intended for
  795.     programmers, and other technically inclined users.  Most users will
  796.     choose to operate SimSystem IIe with the debugger option (on the
  797.     configuration screen) turned OFF, since it significantly reduces the
  798.     speed at which SimSystem IIe operates.
  799.  
  800.     A traditional debugger is a program that resides in memory with the
  801.     program being tested.  The program under test must be reasonably well
  802.     behaved in that it may not trash memory required by the debugger, or
  803.     interact with system hardware in a manner the debugger doesn't expect,
  804.     or both programs will crash.  A debugger is also a useful tool for
  805.     examining how another program works.  Many copy protected programs, or
  806.     programs which use proprietary software techniques or algorithms, are
  807.     specifically designed so that a traditional debugger will not work
  808.     with them.
  809.  
  810.     The SimSystem IIe debugger is different.  It works more like a piece
  811.     of hardware attached to the microprocessor, or an in-circuit emulator
  812.     device.  The SimSystem IIe debugger is not a program that coexists in
  813.     65C02 memory, but is an enhancement to the 65C02 microprocessor
  814.     emulator program.  In fact, the SimSystem IIe debugger was used
  815.     extensively in testing SimSystem IIe.  Using the SimSystem IIe
  816.     debugger, you can view each instruction the 65C02 executes BEFORE it
  817.     actually executes them.  You can stop the processor at any time, view
  818.     its register contents, single step through the instructions, and set
  819.     hardware breakpoints at any address.
  820.  
  821.     Before you can use the SimSystem IIe debugger it must be enabled on
  822.     the configuration screen.
  823.  
  824.     When you execute SimSystem IIe with the debugger enabled you will be
  825.     presented with a box asking you to enter a breakpoint address in
  826.     hexadecimal.  When the 6502 program executes an instruction at the
  827.     specified breakpoint address SimSystem IIe will automatically switch
  828.     into STEP mode (stopping the processor), and the debugger display will
  829.     automatically be turned on.  SimSystem IIe will ONLY stop at
  830.     breakpoint addresses where an instruction begins (i.e., where the
  831.     65C02 processor performs an opcode fetch).  The debugger will NOT stop
  832.     the 65C02 processor if the breakpoint address falls in the middle of
  833.     an instruction.  The breakpoint address you specify will remain in
  834.     effect until you change it.  If you don't want SimSystem IIe to stop
  835.     at any address you may enter FFFF, since this address is part of the
  836.     IRQ interrupt vector, and the 65C02 processor should NEVER execute an
  837.     opcode fetch at this address.
  838.  
  839.     After entering the breakpoint address SimSystem IIe will behave as it
  840.     otherwise would, although somewhat more slowly.  Function keys F1
  841.     through F4 perform special debugger tasks, as described in chapter 9.
  842.  
  843.     Function key F1 will toggle the debugger display on and off. 
  844.     SimSystem IIe slows down even more with the debugger display on, since
  845.     each instruction is displayed as it is executed.
  846.  
  847.                                     Page 20
  848.  
  849.  
  850.  
  851.     Function key F2 will toggle between STEP and RUN mode.  You can
  852.     restart the 65C02 processor after a debugger breakpoint by pressing
  853.     the F2 key.
  854.  
  855.     Function key F3 will display the Set Breakpoint box (just as it was
  856.     displayed at the start of the program) so that you may enter a
  857.     different breakpoint.  You can step past a subroutine call by setting
  858.     the breakpoint to the address of the first instruction after the JSR
  859.     and pressing F2 to restart the 65C02.  SimSystem IIe will return to
  860.     STEP mode after the subroutine returns.
  861.  
  862.     Function key F4 is used to step the 65C02 processor a single
  863.     instruction.
  864.  
  865.     The debugger display looks like this:
  866.  
  867.          PC=1234 SP=0180 A=00 X=FF Y=10 PS=NVBDIZC LDA ($30),Y $8010
  868.  
  869.     The field 'PC=1234' tells us that the current instruction (program
  870.     counter) is at address $1234.  The field 'SP=0180' indicates the
  871.     current address of the stack pointer.  The fields 'A=00', 'X=FF', and
  872.     'Y=10' show the current contents of the three processor data
  873.     registers.  The field 'PS=NVBDIZC' show the processor status bits
  874.     Negative, oVerflow, Break, Decimal, Interrupt disable, Zero, and
  875.     Carry.  The letter representing each bit is only displayed when the
  876.     corresponding bit is ON, otherwise they are displayed as a period. 
  877.     The instruction at the current address is displayed (in this case, LDA
  878.     ($30),Y).  Since indirect addressing is used, the effective address is
  879.     also displayed ($8010).  Since the Y register contains $10, we can
  880.     deduce that the indirect address at zero page location $30 and $31 is
  881.     $8000.
  882.  
  883.     All of the other SimSystem IIe function keys will work normally even
  884.     when the 65C02 processor is halted by the debugger.
  885.  
  886.  
  887.                                     Page 21
  888.  
  889.  
  890.                        Chapter 11 - Volume File Formats
  891.                        ________________________________
  892.  
  893.     It is our hope that everyone who tries SimSystem IIe will find it
  894.     useful, and will choose to pay the reasonable $50 registration fee. 
  895.     As an incentive, we offer the SimDisk program to registered users. 
  896.     With SimDisk you can create volume files for SimSystem IIe, copy files
  897.     from MS-DOS to SimSystem IIe volumes (or vice versa), and generate
  898.     volumes from real Apple diskettes using the Deluxe Option Board, from
  899.     Central Point software.  We also offer an in-depth users manual,
  900.     complete with figures and technical references, printed and
  901.     professionally bound.
  902.  
  903.     In the real world, however, we realize that many people will not pay
  904.     the registration fee regardless of any incentives we provide.  While
  905.     we don't want to remove the incentive to register, we also don't want
  906.     to make it impossible to use SimSystem IIe with anything but the few
  907.     demo programs we provide with it.  In fact, some people may choose NOT
  908.     to register until they can verify whether SimSystem IIe is compatible
  909.     with specific Apple II software.  For this reason we are providing a
  910.     description of the volume files used by SimSystem IIe.  Any moderately
  911.     skilled programmer will be able to create a program that can generate
  912.     the volume files.  Who knows - maybe we'll offer to include such a
  913.     program with future shareware versions of SimSystem IIe, and share the
  914.     registration fee with the programs author...  (It would have to be
  915.     REALLY good, though...)
  916.  
  917.     Floppy (*.IIE) Volumes
  918.  
  919.          Floppy volume files come in two basic flavors; binary and GCR. 
  920.          Both types have the DOS extension *.IIE, and both types begin
  921.          with a header, as follows:
  922.  
  923.               13 bytes - ASCII text "SIMSYSTEM_IIE"
  924.               1 byte - volume type, as follows:
  925.                    00 - binary ProDOS volume
  926.                    01 - binary Apple DOS volume
  927.                    02 - binary unknown operating system
  928.                    03 - GCR unknown operating system
  929.  
  930.          All of the binary formats, 0 through 2, are treated the same by
  931.          SimSystem IIe.  The reference to which operating system format
  932.          they use is for informational purposes only.  Utility programs
  933.          should NOT count on this value to determine the directory format
  934.          for the volume data.
  935.  
  936.          All of the binary format volume files continue, as follows:
  937.  
  938.               16 bytes - sector interleave table
  939.                    This table indicates the physical order of the sectors
  940.                    in each track image.  SimSystem IIe uses this
  941.                    information to create sector address fields when
  942.                    generating GCR data from the volume file data.
  943.               4096 bytes - track 0 data
  944.               4096 bytes - track 1 data
  945.  
  946.                                          Page 22
  947.  
  948.  
  949.               ...
  950.               4096 bytes - track 34 data
  951.  
  952.          All of the GCR format volume files continue, as follows:
  953.  
  954.               37 words - track size table
  955.                    GCR volumes contain data for 37 tracks (as opposed to
  956.                    the normal 35 tracks on an Apple disk).  This is in
  957.                    support of the those Apple copy protection schemes that
  958.                    use extra tracks at the inside diameter of the disk. 
  959.                    Each word in this table (in Intel low byte/high byte
  960.                    order) indicates the size of each GCR track image in
  961.                    bytes.
  962.               ???? bytes - track 0 GCR data
  963.               ???? bytes - track 1 GCR data
  964.               ...
  965.               ???? bytes - track 36 GCR data
  966.  
  967.     Hard Disk (*.HDV) Volumes
  968.  
  969.          SimSystem IIe hard disk volumes always contain binary data.  In
  970.          addition, they are only compatible with Apple ProDOS operating
  971.          systems.  For this reason, the data are stored in ProDOS blocks
  972.          (512 bytes each).
  973.  
  974.          The format of a SimSystem IIe hard disk volume file is as
  975.          follows:
  976.  
  977.               13 bytes - ASCII text "SIMSYSTEM_HDV"
  978.               1 word - size of the volume (low byte/high byte) in ProDOS
  979.               blocks
  980.               512 bytes - block 0 data
  981.               512 bytes - block 1 data
  982.               ...
  983.               512 bytes - last block data
  984.  
  985.          Given the appropriate boot sector data, these volume files can be
  986.          used to boot SimSystem IIe.  Curiously enough, the Apple boot
  987.          sector for a ProDOS volume is identical for a hard drive and a
  988.          floppy disk.  SimSystem IIe hard drive ROM code (slot 7) conforms
  989.          to the Apple standard for a hard disk, and will boot ProDOS from
  990.          a standard Apple volume.
  991.  
  992.          Good Luck!!!
  993.  
  994.  
  995.                                       Page 23
  996.  
  997.  
  998.                               Appendix - Registration
  999.                               _______________________
  1000.  
  1001.     Hopefully, all of this has given you sufficient enticement to break
  1002.     out your check book and send in your registration.  The registration
  1003.     fee is $50 U.S., plus $6 to cover shipping costs.  Make out your check
  1004.     to:
  1005.  
  1006.          American Research Inc.
  1007.          2120 Deercreek Rd.
  1008.          Simi Valley, CA 93065
  1009.  
  1010.     California residents should add the appropriate sales tax.  Your
  1011.     registered copy of SimSystem IIe will be sent out as soon as your
  1012.     check has cleared.  You can save some time by sending a money order or
  1013.     cashiers check, which will get you same day service.
  1014.  
  1015.  
  1016.